#
#  Copyright 2025 The InfiniFlow Authors. All Rights Reserved.
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.

import logging
import boto3
from botocore.exceptions import ClientError
from botocore.config import Config
import time
from io import BytesIO
from rag.utils import singleton
from rag import settings


# 使用 singleton 装饰器确保该类在整个进程中只有一个实例，用于封装 OSS 操作
@singleton
class RAGFlowOSS:
    # 初始化方法，设置连接为 None 并加载 OSS 配置参数，然后尝试建立连接
    def __init__(self):
        # 初始化连接对象为 None
        self.conn = None
        # 获取 OSS 配置信息
        self.oss_config = settings.OSS
        # 从配置中获取访问密钥
        self.access_key = self.oss_config.get('access_key', None)
        # 从配置中获取秘密密钥
        self.secret_key = self.oss_config.get('secret_key', None)
        # 从配置中获取端点 URL
        self.endpoint_url = self.oss_config.get('endpoint_url', None)
        # 从配置中获取区域信息
        self.region = self.oss_config.get('region', None)
        # 从配置中获取默认桶名
        self.bucket = self.oss_config.get('bucket', None)
        # 从配置中获取前缀路径
        self.prefix_path = self.oss_config.get('prefix_path', None)
        # 调用私有方法 __open__ 建立 OSS 连接
        self.__open__()

    # 静态方法装饰器：use_default_bucket 用于包装方法，若设置了默认桶则使用默认桶
    @staticmethod
    def use_default_bucket(method):
        # 包装函数定义，接收 self、bucket 及其他参数
        def wrapper(self, bucket, *args, **kwargs):
            # If there is a default bucket, use the default bucket
            # 如果存在默认桶，则使用默认桶，否则使用传入的 bucket
            actual_bucket = self.bucket if self.bucket else bucket
            # 执行原始方法并返回结果
            return method(self, actual_bucket, *args, **kwargs)
        # 返回包装后的方法
        return wrapper
    
    # 静态方法装饰器：use_prefix_path 用于包装方法，若设置了 prefix_path 则拼接到文件名前
    @staticmethod
    def use_prefix_path(method):
        # 包装函数定义，接收 self、bucket、fnm 及其他参数
        def wrapper(self, bucket, fnm, *args, **kwargs):
            # If the prefix path is set, use the prefix path
            # 如果设置了 prefix_path，则拼接到文件名前，否则保持原文件名
            fnm = f"{self.prefix_path}/{fnm}" if self.prefix_path else fnm
            # 执行原始方法并返回结果
            return method(self, bucket, fnm, *args, **kwargs)
        # 返回包装后的方法
        return wrapper

    # 私有方法 __open__，用于打开或重新建立 OSS 连接
    def __open__(self):
        # 尝试关闭已有连接（如果存在）
        try:
            # 如果 conn 已存在
            if self.conn:
                # 调用 __close__ 方法关闭连接
                self.__close__()
        # 忽略任何异常
        except Exception:
            pass

        # 尝试创建新的 OSS 客户端连接
        try:
            # Reference：https://help.aliyun.com/zh/oss/developer-reference/use-amazon-s3-sdks-to-access-oss
            # 使用 boto3 创建 S3 客户端连接到阿里云 OSS
            self.conn = boto3.client(
                's3',
                region_name=self.region,
                aws_access_key_id=self.access_key,
                aws_secret_access_key=self.secret_key,
                endpoint_url=self.endpoint_url,
                config=Config(s3={"addressing_style": "virtual"}, signature_version='v4')
            )
        # 如果连接失败，记录日志
        except Exception:
            logging.exception(f"Fail to connect at region {self.region}")

    # 私有方法 __close__，用于关闭当前 OSS 连接
    def __close__(self):
        # 删除连接对象
        del self.conn
        # 设置 conn 为 None 表示已关闭
        self.conn = None

    # 使用装饰器 use_default_bucket，检查指定的 bucket 是否存在
    @use_default_bucket
    def bucket_exists(self, bucket):
        # 尝试调用 head_bucket 检查桶是否存在
        try:
            # 记录调试日志，显示当前正在检查的 bucket 名称
            logging.debug(f"head_bucket bucketname {bucket}")
            # 调用 OSS 的 head_bucket 方法获取桶信息
            self.conn.head_bucket(Bucket=bucket)
            # 如果未抛出异常，说明桶存在
            exists = True
        # 捕获客户端错误（例如 404 表示桶不存在）
        except ClientError:
            # 记录异常日志，说明 head_bucket 失败
            logging.exception(f"head_bucket error {bucket}")
            # 设置 exists 为 False 表示桶不存在
            exists = False
        # 返回桶是否存在（True / False）
        return exists

    # 健康检查方法，用于验证 OSS 连接和基本操作是否正常
    def health(self):
        # 获取默认桶名
        bucket = self.bucket
        # 定义测试文件名
        fnm = "txtxtxtxt1"
        # 构造带 prefix_path 的路径并定义测试二进制数据
        fnm, binary = f"{self.prefix_path}/{fnm}" if self.prefix_path else fnm, b"_t@@@1"
        # 如果目标桶不存在
        if not self.bucket_exists(bucket):
            # 创建该桶
            self.conn.create_bucket(Bucket=bucket)
            # 记录创建桶的调试日志
            logging.debug(f"create bucket {bucket} ********")

        # 将测试数据上传到该桶中
        r = self.conn.upload_fileobj(BytesIO(binary), bucket, fnm)
        # 返回上传结果用于判断健康状态
        return r

    # 获取对象属性的方法，目前为空实现
    def get_properties(self, bucket, key):
        # 直接返回空字典，表示无属性信息
        return {}

    # 列出指定目录下的对象列表方法，目前为空实现
    def list(self, bucket, dir, recursive=True):
        # 直接返回空列表，表示无任何对象
        return []

    # 使用 use_prefix_path 和 use_default_bucket 装饰器，将文件上传到 OSS
    @use_prefix_path
    @use_default_bucket
    def put(self, bucket, fnm, binary):
        # 记录调试日志，显示当前上传的桶名和文件名
        logging.debug(f"bucket name {bucket}; filename :{fnm}:")
        # 最多尝试一次上传
        for _ in range(1):
            # 尝试执行上传逻辑
            try:
                # 如果目标桶不存在
                if not self.bucket_exists(bucket):
                    # 创建目标桶
                    self.conn.create_bucket(Bucket=bucket)
                    # 记录创建桶的信息日志
                    logging.info(f"create bucket {bucket} ********")
                # 使用 upload_fileobj 将二进制数据上传至 OSS
                r = self.conn.upload_fileobj(BytesIO(binary), bucket, fnm)

                # 返回上传结果
                return r
            # 出现异常时进入异常处理流程
            except Exception:
                # 记录上传失败的日志
                logging.exception(f"Fail put {bucket}/{fnm}")
                # 重新建立 OSS 连接
                self.__open__()
                # 等待一秒后重试
                time.sleep(1)

    # 使用 use_prefix_path 和 use_default_bucket 装饰器删除指定桶中的对象
    @use_prefix_path
    @use_default_bucket
    def rm(self, bucket, fnm):
        # 尝试调用 delete_object 删除 OSS 中的对象
        try:
            self.conn.delete_object(Bucket=bucket, Key=fnm)
        # 出现异常时记录日志
        except Exception:
            logging.exception(f"Fail rm {bucket}/{fnm}")

    # 使用 use_prefix_path 和 use_default_bucket 装饰器从 OSS 获取指定对象的内容
    @use_prefix_path
    @use_default_bucket
    def get(self, bucket, fnm):
        # 最多尝试一次获取对象
        for _ in range(1):
            # 尝试执行获取操作
            try:
                # 调用 get_object 获取对象流
                r = self.conn.get_object(Bucket=bucket, Key=fnm)
                # 读取对象数据
                object_data = r['Body'].read()
                # 返回读取到的数据
                return object_data
            # 出现异常时重新建立连接并重试
            except Exception:
                logging.exception(f"fail get {bucket}/{fnm}")
                self.__open__()
                time.sleep(1)
        # 如果全部失败则返回 None
        return

    # 使用 use_prefix_path 和 use_default_bucket 装饰器判断指定对象是否存在
    @use_prefix_path
    @use_default_bucket
    def obj_exist(self, bucket, fnm):
        # 尝试调用 head_object 检查对象是否存在
        try:
            if self.conn.head_object(Bucket=bucket, Key=fnm):
                return True
        # 捕获客户端错误（如 404 表示对象不存在）
        except ClientError as e:
            if e.response['Error']['Code'] == '404':
                return False
            else:
                raise

    # 使用 use_prefix_path 和 use_default_bucket 装饰器生成预签名 URL 用于下载对象
    @use_prefix_path
    @use_default_bucket
    def get_presigned_url(self, bucket, fnm, expires):
        # 最多尝试 10 次生成预签名 URL
        for _ in range(10):
            # 尝试生成预签名 URL
            try:
                r = self.conn.generate_presigned_url('get_object',
                                                     Params={'Bucket': bucket,
                                                             'Key': fnm},
                                                     ExpiresIn=expires)

                return r
            # 出现异常时重新连接并等待后重试
            except Exception:
                logging.exception(f"fail get url {bucket}/{fnm}")
                self.__open__()
                time.sleep(1)
        # 如果全部失败则返回 None
        return

